XIQS User Login

Authenticate user and start the XIQS API communication. This command is mandatory for starting to work with XIQS. If not called before all other commands, the XIQS API will immediately end the communication.

String user

User name

String password

User password

The user name and password should match an existing user in database.

Return Code

Integer: OK = 1

[ String: Warning ]

Warning message is not systematic and can be one of

 NO_MASTER_LICENSE

 MASTER_LICENSE_EXPIRED

 MASTER_LICENSE_INVALID

 NO_PARTITION_LICENSE

 PARTITION_LICENSE_EXPIRED

 PARTITION_LICENSE_INVALID

 MASTER_LICENSE_NOTV2

 PARTITION_LICENSE_NOTV2 

Error Data structure ( Error Management )

Possible failure code returns
 *ERR_UNAUTHORIZED (401) ERR_MSG_LOGOUT_FIRST or ERR_MSG_NO_USER
 *ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB
    

logoutXIQS

[REQUEST]
<?xml version="1.0" encoding="UTF-8"?>
<command name="loginXIQS">
  <param type="string">administrator</param>
  <param type="string">iqsim</param>
</command>

[ANSWER (OK)]
<?xml version="1.0" encoding="UTF-8"?>
<event type="return">
  <meta-data>
    <meta-value>
      <name>ret_code</name>
      <pos>1</pos>
    </meta-value>
  </meta-data>
  <param type="integer">1</param>
</event>

[ANSWER (Error)]
<?xml version="1.0" encoding="UTF-8"?>
<event type="error">
  <meta-data>
    <meta-value>
      <name>err_code</name>
      <pos>1</pos>
    </meta-value>
    <meta-value>
      <name>err_desc</name>
      <pos>2</pos>
    </meta-value>
  </meta-data>
  <param type="integer">401</param>
  <param type="string"> err.user.notfound(administrator)</param>
</event>